GetText

/ Assembly List / LJCNetCommon / TextBuilder / GetText

Namespace - LJCNetCommon

Parameters

text - The text value.

addIndent - Indicates if the text can be indented.

allowNewLine - Indicates if a new line can be added.

Returns

The potentially indented and wrapped new text value.

Syntax

C#
public String GetText(String text, Boolean addIndent = True, Boolean allowNewLine = True)

Gets potentially indented and wrapped text.

Remarks

GetText() is a "GetString" method. It creates and returns the potentially indented and wrapped text. It will start the returned text with a new line if the builder already has text.
The applied indent is the product of the class properties IndentCount and IndentCharCount. (IndentCount * IndentCharCount).
The "addIndent" parameter defaults to true. Set it to false to prevent indenting the line further.
The "allowNewLine" parameter defaults to true. Set it to false to prevent starting with a new line.
Wraps the text with a newline if the WrapEnabled parameter is true and the line length is greater than LineLimit.

Example

C#
// Defaults: IndentCharCount = 2, LineLimit = 80, WrapEnabled = false. var tb = new TextBuilder(); tb.Text("This is an appended line."); // The builder keeps track of the current number of indents. tb.AddIndent(); // Example Method: // Starts the text with a newline if the builder already has text // and param allowNewLine = true and builder text does not end with // a newline. // The text begins with the current indent string if param // addIndent = true. // Defaults: addIndent = true, allowNewLine = true. var tempText = tb.GetText("This is an indented line."); tb.AddText(tempText); var result = tb.ToString(); // result: // This is an appended line. // This is an indented line.

// Defaults: IndentCharCount = 2, LineLimit = 80, WrapEnabled = false.
var tb = new TextBuilder();

tb.Text("This is an appended line.");

// The builder keeps track of the current number of indents.
tb.AddIndent();

// Example Method:
// Starts the text with a newline if the builder already has text
// and param allowNewLine = true and builder text does not end with
// a newline.
// The text begins with the current indent string if param
// addIndent = true.
// Defaults: addIndent = true, allowNewLine = true.
var tempText = tb.GetText("This is an indented line.");
tb.AddText(tempText);
var result = tb.ToString();

// result:
// This is an appended line.
//   This is an indented line.